home *** CD-ROM | disk | FTP | other *** search
/ MacFormat 1994 November / macformat-018.iso / Comms Spectacular / Anarchie-121 / Documentation < prev    next >
Encoding:
Text File  |  1994-07-04  |  20.2 KB  |  402 lines  |  [TEXT/ttxt]

  1. Anarchie v1.2.1 © 1993-94 Peter N Lewis.
  2. This program is $10 shareware.
  3.  
  4. “I filled up my disk in 20 minutes!  Before Anarchie it would take
  5. me a good hour or more to download the same amount of stuff!” - Russell Baird
  6.  
  7. As seen on TV (MacNeil/Lehrer show, May 12 1994)
  8.  
  9. As demoed at Apple's World-wide Developers Conference, May 1994
  10.  
  11. Second Place in the Best Scriptable Application category of the Everyday AppleScript(tm) Contest, June 1994.
  12.  
  13. • Contents
  14.  
  15.       What Anarchie Does
  16.       Features
  17.       Using Anarchie
  18.       Using Anarchie via AppleScript
  19.       Limitations
  20.       Small Print
  21.       Warranty
  22.       Fine Print
  23.       How It Works
  24.       Version History
  25.       Acknowledgements
  26.       The Author
  27.  
  28. • What Anarchie Does
  29.  
  30. Anarchie is an FTP and Archie client.  It will let you browse FTP sites, download files, or find them using an archie server.  It requires System 7 and MacTCP 1.1 or later.  Unfortunately many Archie servers are a bit on the flaky side, but don’t worry, just try another server!
  31.  
  32. •Features
  33.  
  34. Drag Manager support.
  35. AppleScritable and Recordable.
  36. Queries Archie servers and lists results.
  37. Gives full access to FTP sites in a connectionless manner.
  38. Save bookmarks to FTP sites for later listing or fetching.
  39. Comes with bookmarks to many popular sites.
  40. Fetches files from list windows with just a double-click.
  41. Supports MacBinary decoding.
  42. Forwards fetched files to StuffIt Expander for decoding.
  43. Fetch&Store files and listings using AppleScript independently of archie.
  44. Uses Fetch’s “Suffix Mapping” to determine file type and transfer mode.
  45. Supports UserLand’s MenuSharing.
  46.  
  47. • Using Anarchie
  48.  
  49. Note: Anarchie is spelled that way, only the first letter is capitalised, and is pronounced “Anarchy”, not “An archie”.
  50.  
  51. Simply launch Anarchie.  Choose Preferences and fill in the info there.  Then choose Archie…, and select a server, choose the kind of search you want done, the maximum number of matches to return, whether the search is case sensitive, and then type in your search request.  Click the Search button.  Anarchie will then attempt to query the selected server.  
  52.  
  53. Important: Note that some servers apear to be VERY unstable, certainly the Australian one comes and goes.  If you can’t get a result from one, just try another.  You can fetch an up to date Archie Server List with the “Fetch Server List” menu command.  Note also that the larger the number of matches you request, the longer it will take to reply.   Usually 20 matches will be plenty.
  54.  
  55. You can also use Anarchie to simply browse around FTP sites.  Choose Get…,  then type in the host you want to FTP to (you can also put in a path name after a colon, or you can type (or Paste) in a URL).  Then click List and it will fetch a listing of that directory.  Then you can double-click folders to fetch further listings.  It behaves like TurboGopher in this respect.  You can also save references to folders to search them later.  Or just use the bookmark files I've provided, for example it lists over a dozen mirrors for the UMich and Info-Mac sites, so if you have trouble connecting to the home sites, try one of the many mirrors.
  56.  
  57. There are three kinds of archie searches:
  58.  
  59. simple substring which just looks for the word you type anywhere in the file name.
  60. pattern matching which looks for names like dehqx*.hqx
  61. regular expressions which looks for names like ^dehqx.*\.hqx$
  62.  
  63. Each can be either case sensitive or case insensitive.  Since the Archie protocol doesn’t support all of these options some are converted into strange looking regular expressions.
  64.  
  65. Anarchie shows you the progress with a wildly inacurate GUESTimate of how long it will take (its not my fault, I just report what the server says).  When the server finishes responding, the results will be displayed.  You can select some entries and copy them (copies as host:path) or option-copy it (as ftp://host/path, which is the URL (Universal Resource Locator) format).  Double-clicking will fetch the file automagically.
  66.  
  67. Anarchie supports using an alex server.  Alex is a file caching system that makes an FTP site with directories like /alex/edu/umich/archive/mac/mac/util/comm.  When you fetch a file from there, it gets the listing and the fetched file from the original archive, and caches the result on the server so if anyone else gets the file, they get it from the alex server.  This is used in Australia to try to cut down on the ftp use of the Australian<->USA link.  It isn’t very reliable.
  68.  
  69. Anarchie supports using an FTP firewall.  The firewall must pretend to be an FTP server, and must accept usernames of the form <user>@<host>, and then carry out the FTP to <host> specifuying a username of <user>.  Anarchie does not support any other kind of firewall, nor does it support any kind of UDP firewall.
  70.  
  71. Anarchie will use the Suffix Mappings you define in Fetch to specify the file type and creator via the file’s suffix (eg .txt).  If it doesn’t recognize the file, it will use binary mode, which means that text files will have carriage returns&linefeeds in them.  There is a cute little drag&drop utility called Drop Text by Todd Wilson that will fix such files with a minimum of fuss.
  72.  
  73. If you have Drag Manager (rumoured to be in System 7.5), then Anarchie will allow you to drag files to or from the Display windows to upload or download files.  Warning: some versions of the Drag Manager will crash if you drag more than one file to the Finder (or will simply ignore files other than the first one).  Also, if you drag files to the trash can, the Drag Manager will show the zooming rectangles to indicate that the operation failed even though it worked fine.
  74.  
  75. Tips:
  76. - Set Fetch’s Suffix Mapping for .txt, since this is used for View File and other things.
  77. - Make sure you have StuffIt Expander.  Setting it to “Delete Originals” is a good idea.
  78. - If an archie server doesn’t answer, try another server.
  79. - If an FTP site is busy, try another.  Try less-known servers first to share the load.
  80. - Make bookmarks for your favorite FTP directories (eg info-mac/game!).
  81. - Use “View Selection” to force files to be downloaded in text mode.
  82. - Most of the Finder Shortcuts work in Anarchie’s listing windows.
  83.       (eg, command-uparrow opens the parent, typing a name selects it, etc)
  84. - Hold down the option key when you double click/select a menu to edit bookmarks.
  85. - Hold down the option key and choose Edit Retry if the FTP name is slightly wrong.
  86. - Use the Show Log command to refetch files by doubleclicking entries
  87. - The Log will be empty unless you enable logging in the Preferences window.
  88. - Use the Clear menu command to remove entries from the Log.
  89.  
  90. • Using Anarchie via AppleScript
  91.  
  92. You can use Anarchie from AppleScript.  It has commands to search an archie server, as well as to fetch a file from an arbitrary ftp site.  You must be careful to set the timeout parameter though, otherwise if will fail if you try to fetch a large file.
  93.  
  94. Example AppleScript:
  95.  
  96. tell application "Anarchie"
  97.   with timeout of 5 * 60 seconds
  98.     find "dehqx" server "archie.internic.net" matches 20 with window
  99.     fetch file "HD:black-cat-startup.hqx" host "sumex-aim.stanford.edu" path "/info-mac/grf/black-cat-startup.hqx"
  100.     list file "HD:listing" host "sumex-aim.stanford.edu" path "/info-mac"
  101.     store file "HD:file" host "sumex-aim.stanford.edu" path "/incoming"
  102.   end timeout
  103. end tell
  104.  
  105. You can also use the “url” field to simplify some commands:
  106. or simpler:
  107.  
  108.     fetch url "sumex-aim.stanford.edu:/info-mac/grf/black-cat-startup.hqx"
  109.     store file "HD:file" url "ftp://user:password@host/path"
  110.  
  111. [Note that the URL can be a proper URL, or a simple “host:path” form]
  112.  
  113. Check out the scripts provide.
  114.  
  115. You’re on your own when it comes to Frontier, I’ve included some stuff from Leonard Rosenthol, but I have no idea what it does - cool and froody things I expect!
  116.  
  117. • Limitations
  118.  
  119. Anarchie requires System 7 and MacTCP 1.1 or later.  For large searches, large listings or many listings or searches or whatever, you may need to increase Anarchie’s memory partition (use Get Info in the Finder to do this).  To display FTP sites, Anarchie assumes the directory listing will look something like a normal Un•x one, if it doesn’t, it won’t work.  I have a document available on how Anarchie (and other programs) parse the LIST output, so if you are writing a server or client, let me know and I’ll send you the document.
  120.  
  121. • Small Print
  122.  
  123. This program is Shareware, which means if you use it, you should send me US$10.  US dollars or personal checks in US dollars drawn on US banks are fine.
  124.  
  125. Site Licensing:
  126. World-Wide Source Code License: US$5000
  127. World-wide license: US$2000
  128. Universities or companies site license: US$500
  129. Curtin University and the University of Western Australia are exempt.
  130. Individuals: US$10.
  131.  
  132. Note that I'd prefer that you use the program and send me a note saying so, than not use the program at all!  (it doesn’t help either of us if you delete it and don’t pay, but this is not to say I am happy about it)  So even if you are not willing to send me any money, still drop me a line and say hi and tell me what you like or don't like about this program.  Of course, I’d much prefer you to pay, obviously.  Better yet, get your organisation to buy a site license.
  133.  
  134. If you purchase a site license, contact me for information on how to make Anarchie automatically set the “I Paid” flag in the Preferences dialog (for those who are interested, I leave the “I Paid” checkbox off on my machine to ensure that the About box is not too annoying and it doesn’t trouble me, so live with it)
  135.  
  136. You may distribute Anarchie any way you wish as long as you don't charge for it (reasonable download costs such as Compu$erve are ok I guess (although who would call Compu$erve’s download costs reasonable?)).  It would probably be a good idea to keep this documentation file with the program, but I’m hardly likely to check up on you now am I!  I don’t guarantee any support, but I always answer my Email.  If I don’t answer Email its because your message didn’t get to me, or my reply bounced, so try again and include a valid Internet address if you can.
  137.  
  138. You MAY NOT DISTRIBUTE this program on any disk costing more than $5 without my explicit permission.
  139.  
  140. • Warranty
  141.  
  142. This program should do what I’ve described in this document.  If it doesn’t, you can simply stop using it.  If you pay me, and within a year find that it doesn’t do what I describe here, then you can notify me and I will refund your money and cancel your license.
  143.  
  144. • Fine Print
  145.  
  146. Peter Lewis hereby disclaims all warranties relating to this software, whether express or implied, including without limitation any implied warranties of merchantability or fitness for a particular purpose.  Peter Lewis will not be liable for any special, incidental, consequential, indirect or similar damages due to loss of data or any other reason, even if Peter Lewis or an agent of his has been advised of the possibility of such damages.  In no event shall Peter Lewis be liable for any damages, regardless of the form of the claim.  The person using the software bears all risk as to the quality and performance of the software.
  147.  
  148. US Governement:
  149.         Government End Users:  If you are acquiring the Software and fonts
  150. on behalf of any unit or agency of the United States Government, the
  151. following provisions apply.  The Government agrees:
  152.         (i) if the Software and fonts are supplied to the Department of
  153. Defense (DoD), the Software and fonts are classified as "Commercial
  154. Computer Software" and the Government is acquiring only "restricted rights"
  155. in the Software, its documentation and fonts as that term is defined in
  156. Clause 252.227-7013(c)(1) of the DFARS; and
  157.         (ii) if the Software and fonts are supplied to any unit or agency
  158. of the United States Government other than DoD, the Government's rights in
  159. the Software, its documentation and fonts will be as defined in Clause
  160. 52.227-19(c)(2) of the FAR or, in the case of NASA, in Clause
  161. 18-52.227-86(d) of the NASA Supplement to the FAR.
  162.  
  163. • How It Works
  164.  
  165. Anarchie connects to the archie server using the UDP prospero protocol and then, thru a complicated dance of exchanged packets, gets a response back which it reassembles into a list and then displays.  The fetching is done with the normal FTP protocol.
  166.  
  167. • Version History
  168.  
  169. Still Todo:
  170. Send MACB command once, and deal with it properly for uploads
  171. read/write FTP commands (rename, put, delete)
  172.   (put, delete work with DragManager)
  173. other FTP commands (site index, arbitrary)
  174. Moveable modal Find window
  175.  
  176. AppleScript: "save listing", "list by date/size/"
  177. cmd-click the window title to get popup of directories
  178. support passwords in bookmark listing windows
  179. support saving passwords in saved bookmarks
  180. support dragging entried to the bookmark list to create bookmarks
  181. true grey for grey rounded rect around default buttons
  182. Regexp helper?
  183. way cool help window with topics and stuff and throw away the documentation files.
  184.  
  185. o autosizing to not showing the path
  186. o option double click to close parent window
  187. o shift tab in get dialog
  188. Option-click headers to sort in reverse (eg au.edu.curtin.info).
  189. "Get Info" like notes for URLs.
  190. Use Expander's Expand event so that I can notify when it's finished.
  191. tcl support?
  192. Remeber last sort, or preference for prefered sort?
  193. fetch a file when it exists should give a helpful prompt.
  194. Try to fetch file.hqx in favour of file.hqx.{Z,z,gz} to see if the site will decode it
  195. Some form of after-search filtering
  196. AE set/get preferences
  197. AE line 3 of window 1
  198. support for gopher and WWW as well ;-)
  199.  
  200. 1.2.1
  201. Bug fix for downloading binary, non-MacBinary files.
  202.  
  203. 1.2.0d7
  204. ~UI changes
  205. ~Drag Manager drag only if you click on the file name or icon.
  206.  
  207. 1.2.0d6
  208. ~pipeline multiple ftp request (especially important for ftp.apple.com).
  209. ~Bookmarks with more than one entry.
  210. ~Unbugged nonymous ftp.
  211. ~No more negative times hopefully :-)
  212. ~support NetWare server
  213.  
  214. 1.2.0d5
  215. ~Fixed? progress colours
  216. ~Drag Manager support
  217.  
  218. 1.2.0d4
  219. ~Save Bookmark should possibly add a string like " Bookmark"
  220. ~Only pay attention to option in odoc event if sent from the finder.
  221. ~revamp zoom code.
  222. ~Edit->Clear on Log window
  223. ~Update Balloon help
  224. ~Save URL bug
  225.  
  226. 1.2.0d3
  227. ~active log (still need to implement clear)
  228. ~Totally reorged the command keys (sorry!)
  229. ~search menu (Find, Find Again, All at once).
  230. ~FTP Transcript
  231. ~reasonably complete support for (readonly) nonymous FTP
  232. ~support partial and absolute paths
  233. ~option-copy in Get dialog copies as URL
  234. ~paste of URL splits across fields.
  235. ~Fixed up the progress bar (oops ;)
  236. ~Added some minor changes to interoperate better with Fetch/NewsWatcher.
  237.  
  238. 1.1.4d1
  239. ~Started on transcripts
  240. ~Fixed a bug that caused some directories to come up empty, and some -49 errors.
  241.  
  242. 1.1.3
  243. Released three times inside 24 hours to become 1.1.3 - don't ask.
  244.  
  245. 1.1.1d3
  246. ~Allow listing host:/path/file*
  247. ~uniquefy the destination name rather than prompting.
  248. ~Cmd-1,2,3 to set radio buttons in each dialog
  249. ~Only numbers in Size and Matches fields.
  250. ~Option-(return, doubleclick,etc) all bring up the Edit dialog now.
  251.  
  252. 1.1.1d2
  253. ~Improve timeout message (just put up "nothing found" window).
  254. ~Time remaining in FTP progress.
  255. ~Using new DNR code (lots of new bugs I expect)
  256. ~Zoom leaves room for disk icons.
  257. ~Fixed a bug that caused “zones” to be incorrect on occasion.
  258. ~Cmd-. or escape while finding terminates the find and displays the results.
  259.  
  260. 1.1.1d1
  261. ~Added prefs for opening the Bookmarks List, and not using Expander.
  262. ~Fixed bug with dot (.) not working in patterns.
  263. ~Open Folder opens a bookmark listing
  264. ~cps display in store/fetch progress?
  265. ~Partial results - really this time.
  266. ~Minor UI fix
  267. ~Added URL support to AppleEvents
  268. ~Added support for "current selection" AppleEvent
  269. ~Fixed bug with binary mode listing transfers (actually a bug in some servers)
  270.  
  271. 1.1.0d7
  272. ~Allow port specification in Firewall.
  273.  
  274. 1.1.0d6
  275. ~Force save rating et al after changes.
  276. ~Fixed some bugs in the cache code (surprise!)
  277. ~Fixed some bugs in the sort code (surprise!)
  278. ~Improved FTP listing compatibility (the Newton site broke it).
  279. ~Minor UI issues and redid balloon help (Thanks Quinn).
  280. ~Minor scroll bar glitch.  Sigh.
  281.  
  282. 1.1.0d5
  283. ~Cache ftp connections to avoid reopening.
  284. ~Increase sort speed by an order of magnitude or two.
  285. ~Randomize (Sorry Jim :-)
  286. ~Fixed colour icons to use only allowed colours, and added bookmark colour icon
  287. ~Trashed pref icons, use file type "pref" to get default icon instead.
  288. ~balloon help for Window menu
  289. ~Dates are not always for THIS year - they are for withing the last year!
  290. ~cmd-uparrow opens parent
  291.  
  292. 1.1.0d4
  293. ~Balloon Help for menus.
  294. ~Regex helper - tutorial.
  295. ~Decode .sit/.cpt files after decoding MacBinary file
  296. ~mastermind.cpt.hqx (in game/board) is NOT a directory :-(
  297. ~Partial results
  298. ~added date and mode to the log.
  299. ~added retry menu (it might even work)
  300. ~position the "save changes" alert.
  301. ~status strings
  302. ~out of disk space gives sensible error (as do other errors)
  303. ~dir name in window listing instead of "Directory Listing"
  304. ~New about box? prompt? display usage?  Newbie rating
  305.  
  306. 1.1.0d3
  307. ~Log file (does it need more info?)
  308. ~Barber poll progress
  309. ~Pg up/down, home/end keys
  310. ~Balloon Help
  311. ~increase memory to 300k?
  312. ~Save Bookmarks of list window gives no default name
  313. ~Out of memory dialog is not big enough
  314. ~archie comes up with no server selected???
  315. ~cmd keys for fetch list/fetch file? (cmd-1 & cmd-2)
  316. ~Edit *menu* doesn't work
  317. ~Make button light up on paste
  318. ~TEXT mode solution (View Selection)
  319. ~Automagic MacBinary detection.
  320. ~option-close box & Command-option-W
  321. ~close box -> AppleEvent
  322. ~Finder shortcuts
  323.  
  324. 1.1.0d2
  325. ~Windows menu.
  326. ~Full connectionless anonymous FTP client.
  327. ~Saveable URL documents
  328. ~Non-modal Get File/Directory dialog.
  329. ~double-click dir brings up list of files similar to archie list
  330.  
  331. 1.1.0d1
  332. ~Finder-like "Name, Size, etc header" with sorting
  333. ~Improved "no result" display
  334. ~Support FTP firewalls. (do they all behave the same?)
  335. ~Preference to open Find window on startup.
  336. ~Added the server name to the listing window’s title.
  337. ~Supports windows wider than 1000 pixels (well, I don't have one :-)
  338. ~Only use "-" in password for anonymous logins, since some servers don't handle it.
  339.  
  340. 1.0.0 - First release
  341. ~AE store & list
  342. ~GrowZone
  343. ~MenuSharing.
  344. ~Fixed popup UI to abide by Apple’s HIG.
  345. ~Alex server support
  346. ~Multiple selections in the list window.
  347. ~Scriptable&Recordable fetch command
  348. ~Fetch SuffixMapping
  349. ~Send to StuffIt Expander
  350. ~Prefs dialog
  351.  
  352. • Acknowledgements
  353.  
  354. Thank go to Dmitry Boldyrev & Igor Livshits for the icons, and to various people on my beta list for their suggestions.  Quinn & Leonard get the award for most implemented suggestions.
  355.  
  356. Thanks again to Leonard for the Frontier stuff.  Don’t ask me what it is, I’m just including it - anything Leonard writes is certainly going to be good :-)
  357.  
  358. Thanks also to Chris W Johnson and the folks at University of Texas at Austin for hosting the archie server list fetched by “Fetch Server List”.  You might like to check out their archive at microlib.cc.utexas.edu:microlib/mac (preferably after hours).
  359.  
  360. Thanks also to Jean-Pierre Kuypers for the french translation.
  361.  
  362. • The Author
  363.  
  364. Programs written by me:
  365. Anarchie 1.2.1 - Macintosh FTP and Archie client.
  366. TFTPd 1.0.0 - Macintosh TFTP server.
  367. CDIconKiller 1.0.0 - Supress custom icons on CDs (written with Quinn).
  368. MungeImage 1.1.0 - Mount DiskCopy images (written with Quinn).
  369. Morpion 1.0.0 - A simple solitaire game.
  370. FTPd 2.2.0 - Macintosh FTP server.
  371. Daemon 1.0.0 - Macintosh multi-protocol daemon.
  372. Script Daemon 1.0.0 - Telnet->AppleScript gateway
  373. DeHQX 2.0.1 - BinHex decoder (use StuffIt Expander instead).
  374. Finger 1.3.7 - Macintosh Finger client/daemon.
  375. Talk 1.1.1 - Macintosh Talk client/daemon.
  376. MacTCP Watcher 1.1.0 - Display MacTCP’s state information.
  377. MacBinary II+ 1.0.2 - MacBinary II+ encoder/decoder.
  378. ObiWan 4.0.1 - Online help system.
  379. Bolo Finder 1.0.2 - Display the results from Mike Ellis' Bolo Tracker.
  380. Bolo RandomMap 1.1.0 - Generate a random map for Bolo.
  381. FetchNews 1.0.0b - Fetch News for use with NewsWatcher’s demo mode.
  382. Chat 1.1.0 - Multiuser primitive irc-like daemon.
  383.  
  384. The latest versions of my programs are available from:
  385. amug.org:pub/peterlewis
  386. nic.switch.ch:/mac/software/peterlewis
  387. redback.cs.uwa.edu.au:/others/peterlewis
  388. and French versions of some of my programs may be available from: ftp.sri.ucl.ac.be:/pub
  389.  
  390. Send postcards, comments, bug reports, wishes, and payments to:
  391.  
  392. Peter Lewis,
  393. 10 Earlston Way,
  394. Booragoon, WA, 6154,
  395. AUSTRALIA
  396.  
  397. or by electronic mail to:
  398.  
  399. Internet: peter.lewis@info.curtin.edu.au
  400. Bitnet: peter.lewis%info.curtin.edu.au@cunyvm.bitnet
  401. UUCP: uunet!munnari.oz!info.curtin.edu.au!peter.lewis
  402.